Download OpenAPI specification:Download
| id required | string the id of the requested resource |
AgeRatingDeclaration representation
required | object |
{- "data": {
- "type": "ageRatingDeclarations",
- "id": "string",
- "attributes": {
- "alcoholTobaccoOrDrugUseOrReferences": "NONE",
- "gamblingAndContests": true,
- "gamblingSimulated": "NONE",
- "kidsAgeBand": "FIVE_AND_UNDER",
- "medicalOrTreatmentInformation": "NONE",
- "profanityOrCrudeHumor": "NONE",
- "sexualContentGraphicAndNudity": "NONE",
- "sexualContentOrNudity": "NONE",
- "horrorOrFearThemes": "NONE",
- "matureOrSuggestiveThemes": "NONE",
- "unrestrictedWebAccess": true,
- "violenceCartoonOrFantasy": "NONE",
- "violenceRealisticProlongedGraphicOrSadistic": "NONE",
- "violenceRealistic": "NONE"
}
}
}{- "data": {
- "type": "ageRatingDeclarations",
- "id": "string",
- "attributes": {
- "alcoholTobaccoOrDrugUseOrReferences": "NONE",
- "gamblingAndContests": true,
- "gamblingSimulated": "NONE",
- "kidsAgeBand": "FIVE_AND_UNDER",
- "medicalOrTreatmentInformation": "NONE",
- "profanityOrCrudeHumor": "NONE",
- "sexualContentGraphicAndNudity": "NONE",
- "sexualContentOrNudity": "NONE",
- "horrorOrFearThemes": "NONE",
- "matureOrSuggestiveThemes": "NONE",
- "unrestrictedWebAccess": true,
- "violenceCartoonOrFantasy": "NONE",
- "violenceRealisticProlongedGraphicOrSadistic": "NONE",
- "violenceRealistic": "NONE"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| filter[platforms] | Array of strings Items Enum: "IOS" "MAC_OS" "TV_OS" filter by attribute 'platforms' |
| exists[parent] | Array of strings filter by existence or non-existence of related 'parent' |
| fields[appCategories] | Array of strings Items Enum: "parent" "platforms" "subcategories" the fields to include for returned resources of type appCategories |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "parent" "subcategories" comma-separated list of relationships to include |
| limit[subcategories] | integer <= 50 maximum number of related subcategories returned (when they are included) |
{- "data": [
- {
- "type": "appCategories",
- "id": "string",
- "attributes": {
- "platforms": [
- "IOS"
]
}, - "relationships": {
- "subcategories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appCategories",
- "id": "string"
}
]
}, - "parent": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "appCategories",
- "id": "string",
- "attributes": {
- "platforms": [
- "IOS"
]
}, - "relationships": {
- "subcategories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appCategories",
- "id": "string"
}
]
}, - "parent": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[appCategories] | Array of strings Items Enum: "parent" "platforms" "subcategories" the fields to include for returned resources of type appCategories |
| include | Array of strings Items Enum: "parent" "subcategories" comma-separated list of relationships to include |
| limit[subcategories] | integer <= 50 maximum number of related subcategories returned (when they are included) |
{- "data": {
- "type": "appCategories",
- "id": "string",
- "attributes": {
- "platforms": [
- "IOS"
]
}, - "relationships": {
- "subcategories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appCategories",
- "id": "string"
}
]
}, - "parent": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appCategories",
- "id": "string",
- "attributes": {
- "platforms": [
- "IOS"
]
}, - "relationships": {
- "subcategories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appCategories",
- "id": "string"
}
]
}, - "parent": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| filter[platform] | Array of strings Items Enum: "IOS" "MAC_OS" "TV_OS" filter by attribute 'platform' |
| filter[app] | Array of strings filter by id(s) of related 'app' |
| filter[builds] | Array of strings filter by id(s) of related 'builds' |
| fields[appEncryptionDeclarations] | Array of strings Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption" the fields to include for returned resources of type appEncryptionDeclarations |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": [
- {
- "type": "appEncryptionDeclarations",
- "id": "string",
- "attributes": {
- "usesEncryption": true,
- "exempt": true,
- "containsProprietaryCryptography": true,
- "containsThirdPartyCryptography": true,
- "availableOnFrenchStore": true,
- "platform": "IOS",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "documentUrl": "string",
- "documentName": "string",
- "documentType": "string",
- "appEncryptionDeclarationState": "IN_REVIEW",
- "codeValue": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[appEncryptionDeclarations] | Array of strings Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption" the fields to include for returned resources of type appEncryptionDeclarations |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": {
- "type": "appEncryptionDeclarations",
- "id": "string",
- "attributes": {
- "usesEncryption": true,
- "exempt": true,
- "containsProprietaryCryptography": true,
- "containsThirdPartyCryptography": true,
- "availableOnFrenchStore": true,
- "platform": "IOS",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "documentUrl": "string",
- "documentName": "string",
- "documentType": "string",
- "appEncryptionDeclarationState": "IN_REVIEW",
- "codeValue": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppInfoLocalization representation
required | object |
{- "data": {
- "type": "appInfoLocalizations",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "data": {
- "type": "appInfos",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appInfos",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appInfoLocalizations] | Array of strings Items Enum: "appInfo" "locale" "name" "privacyPolicyText" "privacyPolicyUrl" "subtitle" the fields to include for returned resources of type appInfoLocalizations |
| include | Array of strings Items Value: "appInfo" comma-separated list of relationships to include |
{- "data": {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appInfos",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppInfoLocalization representation
required | object |
{- "data": {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}
}
}{- "data": {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appInfos",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| fields[appInfos] | Array of strings Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo" the fields to include for returned resources of type appInfos |
| include | Array of strings Items Enum: "app" "appInfoLocalizations" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo" comma-separated list of relationships to include |
| fields[appCategories] | Array of strings Items Enum: "parent" "platforms" "subcategories" the fields to include for returned resources of type appCategories |
| fields[appInfoLocalizations] | Array of strings Items Enum: "appInfo" "locale" "name" "privacyPolicyText" "privacyPolicyUrl" "subtitle" the fields to include for returned resources of type appInfoLocalizations |
| limit[appInfoLocalizations] | integer <= 50 maximum number of related appInfoLocalizations returned (when they are included) |
{- "data": {
- "type": "appInfos",
- "id": "string",
- "attributes": {
- "appStoreState": "DEVELOPER_REMOVED_FROM_SALE",
- "appStoreAgeRating": "FOUR_PLUS",
- "brazilAgeRating": "L",
- "kidsAgeBand": "FIVE_AND_UNDER"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "appInfoLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfoLocalizations",
- "id": "string"
}
]
}, - "primaryCategory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryOne": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryTwo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondaryCategory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryOne": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryTwo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appInfos",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppInfo representation
required | object |
{- "data": {
- "type": "appInfos",
- "id": "string",
- "relationships": {
- "primaryCategory": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryOne": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryTwo": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondaryCategory": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryOne": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryTwo": {
- "data": {
- "type": "appCategories",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appInfos",
- "id": "string",
- "attributes": {
- "appStoreState": "DEVELOPER_REMOVED_FROM_SALE",
- "appStoreAgeRating": "FOUR_PLUS",
- "brazilAgeRating": "L",
- "kidsAgeBand": "FIVE_AND_UNDER"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "appInfoLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfoLocalizations",
- "id": "string"
}
]
}, - "primaryCategory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryOne": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "primarySubcategoryTwo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondaryCategory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryOne": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}, - "secondarySubcategoryTwo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appCategories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appInfoLocalizations",
- "id": "string",
- "attributes": {
- "locale": "string",
- "name": "string",
- "subtitle": "string",
- "privacyPolicyUrl": "string",
- "privacyPolicyText": "string"
}, - "relationships": {
- "appInfo": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appInfos",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}AppPreOrder representation
required | object |
{- "data": {
- "type": "appPreOrders",
- "attributes": {
- "appReleaseDate": "2019-08-24"
}, - "relationships": {
- "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appPreOrders",
- "id": "string",
- "attributes": {
- "preOrderAvailableDate": "2019-08-24",
- "appReleaseDate": "2019-08-24"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appPreOrders] | Array of strings Items Enum: "app" "appReleaseDate" "preOrderAvailableDate" the fields to include for returned resources of type appPreOrders |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
{- "data": {
- "type": "appPreOrders",
- "id": "string",
- "attributes": {
- "preOrderAvailableDate": "2019-08-24",
- "appReleaseDate": "2019-08-24"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppPreOrder representation
required | object |
{- "data": {
- "type": "appPreOrders",
- "id": "string",
- "attributes": {
- "appReleaseDate": "2019-08-24"
}
}
}{- "data": {
- "type": "appPreOrders",
- "id": "string",
- "attributes": {
- "preOrderAvailableDate": "2019-08-24",
- "appReleaseDate": "2019-08-24"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppPreviewSet representation
required | object |
{- "data": {
- "type": "appPreviewSets",
- "attributes": {
- "previewType": "IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appPreviewSets",
- "id": "string",
- "attributes": {
- "previewType": "IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appPreviews": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPreviews",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string",
- "videoUrl": "string",
- "previewImage": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appPreviewSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appPreviewSets] | Array of strings Items Enum: "appPreviews" "appStoreVersionLocalization" "previewType" the fields to include for returned resources of type appPreviewSets |
| include | Array of strings Items Enum: "appPreviews" "appStoreVersionLocalization" comma-separated list of relationships to include |
| fields[appPreviews] | Array of strings Items Enum: "appPreviewSet" "assetDeliveryState" "fileName" "fileSize" "mimeType" "previewFrameTimeCode" "previewImage" "sourceFileChecksum" "uploadOperations" "uploaded" "videoUrl" the fields to include for returned resources of type appPreviews |
| limit[appPreviews] | integer <= 50 maximum number of related appPreviews returned (when they are included) |
{- "data": {
- "type": "appPreviewSets",
- "id": "string",
- "attributes": {
- "previewType": "IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appPreviews": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPreviews",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string",
- "videoUrl": "string",
- "previewImage": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appPreviewSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "appPreviews",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "appPreviews",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppPreview representation
required | object |
{- "data": {
- "type": "appPreviews",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string"
}, - "relationships": {
- "appPreviewSet": {
- "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string",
- "videoUrl": "string",
- "previewImage": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appPreviewSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appPreviews] | Array of strings Items Enum: "appPreviewSet" "assetDeliveryState" "fileName" "fileSize" "mimeType" "previewFrameTimeCode" "previewImage" "sourceFileChecksum" "uploadOperations" "uploaded" "videoUrl" the fields to include for returned resources of type appPreviews |
| include | Array of strings Items Value: "appPreviewSet" comma-separated list of relationships to include |
{- "data": {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string",
- "videoUrl": "string",
- "previewImage": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appPreviewSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppPreview representation
required | object |
{- "data": {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "uploaded": true
}
}
}{- "data": {
- "type": "appPreviews",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "previewFrameTimeCode": "string",
- "mimeType": "string",
- "videoUrl": "string",
- "previewImage": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appPreviewSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreviewSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[priceTier] | Array of strings filter by id(s) of related 'priceTier' |
| filter[territory] | Array of strings filter by id(s) of related 'territory' |
| fields[appPricePoints] | Array of strings Items Enum: "customerPrice" "priceTier" "proceeds" "territory" the fields to include for returned resources of type appPricePoints |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "priceTier" "territory" comma-separated list of relationships to include |
| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
{- "data": [
- {
- "type": "appPricePoints",
- "id": "string",
- "attributes": {
- "customerPrice": "string",
- "proceeds": "string"
}, - "relationships": {
- "priceTier": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPriceTiers",
- "id": "string"
}
}, - "territory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "territories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[appPricePoints] | Array of strings Items Enum: "customerPrice" "priceTier" "proceeds" "territory" the fields to include for returned resources of type appPricePoints |
| include | Array of strings Items Enum: "priceTier" "territory" comma-separated list of relationships to include |
| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
{- "data": {
- "type": "appPricePoints",
- "id": "string",
- "attributes": {
- "customerPrice": "string",
- "proceeds": "string"
}, - "relationships": {
- "priceTier": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPriceTiers",
- "id": "string"
}
}, - "territory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "territories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| filter[id] | Array of strings filter by id(s) |
| fields[appPriceTiers] | Array of strings Items Value: "pricePoints" the fields to include for returned resources of type appPriceTiers |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "pricePoints" comma-separated list of relationships to include |
| fields[appPricePoints] | Array of strings Items Enum: "customerPrice" "priceTier" "proceeds" "territory" the fields to include for returned resources of type appPricePoints |
| limit[pricePoints] | integer <= 50 maximum number of related pricePoints returned (when they are included) |
{- "data": [
- {
- "type": "appPriceTiers",
- "id": "string",
- "relationships": {
- "pricePoints": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPricePoints",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "appPricePoints",
- "id": "string",
- "attributes": {
- "customerPrice": "string",
- "proceeds": "string"
}, - "relationships": {
- "priceTier": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPriceTiers",
- "id": "string"
}
}, - "territory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "territories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[appPriceTiers] | Array of strings Items Value: "pricePoints" the fields to include for returned resources of type appPriceTiers |
| include | Array of strings Items Value: "pricePoints" comma-separated list of relationships to include |
| fields[appPricePoints] | Array of strings Items Enum: "customerPrice" "priceTier" "proceeds" "territory" the fields to include for returned resources of type appPricePoints |
| limit[pricePoints] | integer <= 50 maximum number of related pricePoints returned (when they are included) |
{- "data": {
- "type": "appPriceTiers",
- "id": "string",
- "relationships": {
- "pricePoints": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPricePoints",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appPricePoints",
- "id": "string",
- "attributes": {
- "customerPrice": "string",
- "proceeds": "string"
}, - "relationships": {
- "priceTier": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPriceTiers",
- "id": "string"
}
}, - "territory": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "territories",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appPrices] | Array of strings Items Enum: "app" "priceTier" the fields to include for returned resources of type appPrices |
| include | Array of strings Items Enum: "app" "priceTier" comma-separated list of relationships to include |
{- "data": {
- "type": "appPrices",
- "id": "string",
- "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "priceTier": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPriceTiers",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}AppScreenshotSet representation
required | object |
{- "data": {
- "type": "appScreenshotSets",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appScreenshotSets",
- "id": "string",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appScreenshots": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "imageAsset": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "assetToken": "string",
- "assetType": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appScreenshotSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appScreenshotSets] | Array of strings Items Enum: "appScreenshots" "appStoreVersionLocalization" "screenshotDisplayType" the fields to include for returned resources of type appScreenshotSets |
| include | Array of strings Items Enum: "appScreenshots" "appStoreVersionLocalization" comma-separated list of relationships to include |
| fields[appScreenshots] | Array of strings Items Enum: "appScreenshotSet" "assetDeliveryState" "assetToken" "assetType" "fileName" "fileSize" "imageAsset" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type appScreenshots |
| limit[appScreenshots] | integer <= 50 maximum number of related appScreenshots returned (when they are included) |
{- "data": {
- "type": "appScreenshotSets",
- "id": "string",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appScreenshots": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "imageAsset": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "assetToken": "string",
- "assetType": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appScreenshotSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppScreenshot representation
required | object |
{- "data": {
- "type": "appScreenshots",
- "attributes": {
- "fileSize": 0,
- "fileName": "string"
}, - "relationships": {
- "appScreenshotSet": {
- "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "imageAsset": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "assetToken": "string",
- "assetType": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appScreenshotSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appScreenshots] | Array of strings Items Enum: "appScreenshotSet" "assetDeliveryState" "assetToken" "assetType" "fileName" "fileSize" "imageAsset" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type appScreenshots |
| include | Array of strings Items Value: "appScreenshotSet" comma-separated list of relationships to include |
{- "data": {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "imageAsset": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "assetToken": "string",
- "assetType": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appScreenshotSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppScreenshot representation
required | object |
{- "data": {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "sourceFileChecksum": "string",
- "uploaded": true
}
}
}{- "data": {
- "type": "appScreenshots",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "imageAsset": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "assetToken": "string",
- "assetType": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appScreenshotSet": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appScreenshotSets",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppStoreReviewAttachment representation
required | object |
{- "data": {
- "type": "appStoreReviewAttachments",
- "attributes": {
- "fileSize": 0,
- "fileName": "string"
}, - "relationships": {
- "appStoreReviewDetail": {
- "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appStoreReviewAttachments] | Array of strings Items Enum: "appStoreReviewDetail" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type appStoreReviewAttachments |
| include | Array of strings Items Value: "appStoreReviewDetail" comma-separated list of relationships to include |
{- "data": {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppStoreReviewAttachment representation
required | object |
{- "data": {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "sourceFileChecksum": "string",
- "uploaded": true
}
}
}{- "data": {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppStoreReviewDetail representation
required | object |
{- "data": {
- "type": "appStoreReviewDetails",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appStoreReviewAttachments": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appStoreReviewDetails] | Array of strings Items Enum: "appStoreReviewAttachments" "appStoreVersion" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type appStoreReviewDetails |
| include | Array of strings Items Enum: "appStoreReviewAttachments" "appStoreVersion" comma-separated list of relationships to include |
| fields[appStoreReviewAttachments] | Array of strings Items Enum: "appStoreReviewDetail" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type appStoreReviewAttachments |
| limit[appStoreReviewAttachments] | integer <= 50 maximum number of related appStoreReviewAttachments returned (when they are included) |
{- "data": {
- "type": "appStoreReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appStoreReviewAttachments": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppStoreReviewDetail representation
required | object |
{- "data": {
- "type": "appStoreReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}
}
}{- "data": {
- "type": "appStoreReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appStoreReviewAttachments": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appStoreReviewAttachments",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}AppStoreVersionLocalization representation
required | object |
{- "data": {
- "type": "appStoreVersionLocalizations",
- "attributes": {
- "description": "string",
- "locale": "string",
- "keywords": "string",
- "promotionalText": "string",
- "whatsNew": "string"
}, - "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string",
- "attributes": {
- "description": "string",
- "locale": "string",
- "keywords": "string",
- "promotionalText": "string",
- "whatsNew": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appScreenshotSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshotSets",
- "id": "string"
}
]
}, - "appPreviewSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPreviewSets",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appScreenshotSets",
- "id": "string",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appScreenshots": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appStoreVersionLocalizations] | Array of strings Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion" "description" "keywords" "locale" "marketingUrl" "promotionalText" "supportUrl" "whatsNew" the fields to include for returned resources of type appStoreVersionLocalizations |
| include | Array of strings Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion" comma-separated list of relationships to include |
| fields[appScreenshotSets] | Array of strings Items Enum: "appScreenshots" "appStoreVersionLocalization" "screenshotDisplayType" the fields to include for returned resources of type appScreenshotSets |
| fields[appPreviewSets] | Array of strings Items Enum: "appPreviews" "appStoreVersionLocalization" "previewType" the fields to include for returned resources of type appPreviewSets |
| limit[appPreviewSets] | integer <= 50 maximum number of related appPreviewSets returned (when they are included) |
| limit[appScreenshotSets] | integer <= 50 maximum number of related appScreenshotSets returned (when they are included) |
{- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string",
- "attributes": {
- "description": "string",
- "locale": "string",
- "keywords": "string",
- "promotionalText": "string",
- "whatsNew": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appScreenshotSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshotSets",
- "id": "string"
}
]
}, - "appPreviewSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPreviewSets",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appScreenshotSets",
- "id": "string",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appScreenshots": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppStoreVersionLocalization representation
required | object |
{- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string",
- "attributes": {
- "description": "string",
- "keywords": "string",
- "promotionalText": "string",
- "whatsNew": "string"
}
}
}{- "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string",
- "attributes": {
- "description": "string",
- "locale": "string",
- "keywords": "string",
- "promotionalText": "string",
- "whatsNew": "string"
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "appScreenshotSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshotSets",
- "id": "string"
}
]
}, - "appPreviewSets": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPreviewSets",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "appScreenshotSets",
- "id": "string",
- "attributes": {
- "screenshotDisplayType": "APP_IPHONE_65"
}, - "relationships": {
- "appStoreVersionLocalization": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
}, - "appScreenshots": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appScreenshots",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppStoreVersionPhasedRelease representation
required | object |
{- "data": {
- "type": "appStoreVersionPhasedReleases",
- "attributes": {
- "phasedReleaseState": "INACTIVE"
}, - "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string",
- "attributes": {
- "phasedReleaseState": "INACTIVE",
- "startDate": "2019-08-24T14:15:22Z",
- "totalPauseDuration": 0,
- "currentDayNumber": 0
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppStoreVersionPhasedRelease representation
required | object |
{- "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string",
- "attributes": {
- "phasedReleaseState": "INACTIVE"
}
}
}{- "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string",
- "attributes": {
- "phasedReleaseState": "INACTIVE",
- "startDate": "2019-08-24T14:15:22Z",
- "totalPauseDuration": 0,
- "currentDayNumber": 0
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppStoreVersionSubmission representation
required | object |
{- "data": {
- "type": "appStoreVersionSubmissions",
- "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreVersionSubmissions",
- "id": "string",
- "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}AppStoreVersion representation
required | object |
{- "data": {
- "type": "appStoreVersions",
- "attributes": {
- "platform": "IOS",
- "versionString": "string",
- "copyright": "string",
- "releaseType": "MANUAL",
- "earliestReleaseDate": "2019-08-24T14:15:22Z",
- "usesIdfa": true
}, - "relationships": {
- "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}, - "build": {
- "data": {
- "type": "builds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreVersions",
- "id": "string",
- "attributes": {
- "platform": "IOS",
- "versionString": "string",
- "appStoreState": "DEVELOPER_REMOVED_FROM_SALE",
- "copyright": "string",
- "releaseType": "MANUAL",
- "earliestReleaseDate": "2019-08-24T14:15:22Z",
- "usesIdfa": true,
- "downloadable": true,
- "createdDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "ageRatingDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "ageRatingDeclarations",
- "id": "string"
}
}, - "appStoreVersionLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
]
}, - "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}, - "appStoreVersionPhasedRelease": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string"
}
}, - "routingAppCoverage": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "routingAppCoverages",
- "id": "string"
}
}, - "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}, - "appStoreVersionSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionSubmissions",
- "id": "string"
}
}, - "idfaDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "idfaDeclarations",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "ageRatingDeclarations",
- "id": "string",
- "attributes": {
- "alcoholTobaccoOrDrugUseOrReferences": "NONE",
- "gamblingAndContests": true,
- "gamblingSimulated": "NONE",
- "kidsAgeBand": "FIVE_AND_UNDER",
- "medicalOrTreatmentInformation": "NONE",
- "profanityOrCrudeHumor": "NONE",
- "sexualContentGraphicAndNudity": "NONE",
- "sexualContentOrNudity": "NONE",
- "horrorOrFearThemes": "NONE",
- "matureOrSuggestiveThemes": "NONE",
- "unrestrictedWebAccess": true,
- "violenceCartoonOrFantasy": "NONE",
- "violenceRealisticProlongedGraphicOrSadistic": "NONE",
- "violenceRealistic": "NONE"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[appStoreVersions] | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString" the fields to include for returned resources of type appStoreVersions |
| include | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "idfaDeclaration" "routingAppCoverage" comma-separated list of relationships to include |
| fields[appStoreVersionLocalizations] | Array of strings Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion" "description" "keywords" "locale" "marketingUrl" "promotionalText" "supportUrl" "whatsNew" the fields to include for returned resources of type appStoreVersionLocalizations |
| fields[idfaDeclarations] | Array of strings Items Enum: "appStoreVersion" "attributesActionWithPreviousAd" "attributesAppInstallationToPreviousAd" "honorsLimitedAdTracking" "servesAds" the fields to include for returned resources of type idfaDeclarations |
| fields[routingAppCoverages] | Array of strings Items Enum: "appStoreVersion" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type routingAppCoverages |
| fields[appStoreVersionPhasedReleases] | Array of strings Items Enum: "appStoreVersion" "currentDayNumber" "phasedReleaseState" "startDate" "totalPauseDuration" the fields to include for returned resources of type appStoreVersionPhasedReleases |
| fields[ageRatingDeclarations] | Array of strings Items Enum: "alcoholTobaccoOrDrugUseOrReferences" "gamblingAndContests" "gamblingSimulated" "horrorOrFearThemes" "kidsAgeBand" "matureOrSuggestiveThemes" "medicalOrTreatmentInformation" "profanityOrCrudeHumor" "sexualContentGraphicAndNudity" "sexualContentOrNudity" "unrestrictedWebAccess" "violenceCartoonOrFantasy" "violenceRealistic" "violenceRealisticProlongedGraphicOrSadistic" the fields to include for returned resources of type ageRatingDeclarations |
| fields[appStoreReviewDetails] | Array of strings Items Enum: "appStoreReviewAttachments" "appStoreVersion" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type appStoreReviewDetails |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[appStoreVersionSubmissions] | Array of strings Items Value: "appStoreVersion" the fields to include for returned resources of type appStoreVersionSubmissions |
| limit[appStoreVersionLocalizations] | integer <= 50 maximum number of related appStoreVersionLocalizations returned (when they are included) |
{- "data": {
- "type": "appStoreVersions",
- "id": "string",
- "attributes": {
- "platform": "IOS",
- "versionString": "string",
- "appStoreState": "DEVELOPER_REMOVED_FROM_SALE",
- "copyright": "string",
- "releaseType": "MANUAL",
- "earliestReleaseDate": "2019-08-24T14:15:22Z",
- "usesIdfa": true,
- "downloadable": true,
- "createdDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "ageRatingDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "ageRatingDeclarations",
- "id": "string"
}
}, - "appStoreVersionLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
]
}, - "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}, - "appStoreVersionPhasedRelease": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string"
}
}, - "routingAppCoverage": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "routingAppCoverages",
- "id": "string"
}
}, - "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}, - "appStoreVersionSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionSubmissions",
- "id": "string"
}
}, - "idfaDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "idfaDeclarations",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "ageRatingDeclarations",
- "id": "string",
- "attributes": {
- "alcoholTobaccoOrDrugUseOrReferences": "NONE",
- "gamblingAndContests": true,
- "gamblingSimulated": "NONE",
- "kidsAgeBand": "FIVE_AND_UNDER",
- "medicalOrTreatmentInformation": "NONE",
- "profanityOrCrudeHumor": "NONE",
- "sexualContentGraphicAndNudity": "NONE",
- "sexualContentOrNudity": "NONE",
- "horrorOrFearThemes": "NONE",
- "matureOrSuggestiveThemes": "NONE",
- "unrestrictedWebAccess": true,
- "violenceCartoonOrFantasy": "NONE",
- "violenceRealisticProlongedGraphicOrSadistic": "NONE",
- "violenceRealistic": "NONE"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
AppStoreVersion representation
required | object |
{- "data": {
- "type": "appStoreVersions",
- "id": "string",
- "attributes": {
- "versionString": "string",
- "copyright": "string",
- "releaseType": "MANUAL",
- "earliestReleaseDate": "2019-08-24T14:15:22Z",
- "usesIdfa": true,
- "downloadable": true
}, - "relationships": {
- "build": {
- "data": {
- "type": "builds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "appStoreVersions",
- "id": "string",
- "attributes": {
- "platform": "IOS",
- "versionString": "string",
- "appStoreState": "DEVELOPER_REMOVED_FROM_SALE",
- "copyright": "string",
- "releaseType": "MANUAL",
- "earliestReleaseDate": "2019-08-24T14:15:22Z",
- "usesIdfa": true,
- "downloadable": true,
- "createdDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "ageRatingDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "ageRatingDeclarations",
- "id": "string"
}
}, - "appStoreVersionLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersionLocalizations",
- "id": "string"
}
]
}, - "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}, - "appStoreVersionPhasedRelease": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionPhasedReleases",
- "id": "string"
}
}, - "routingAppCoverage": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "routingAppCoverages",
- "id": "string"
}
}, - "appStoreReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreReviewDetails",
- "id": "string"
}
}, - "appStoreVersionSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersionSubmissions",
- "id": "string"
}
}, - "idfaDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "idfaDeclarations",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "ageRatingDeclarations",
- "id": "string",
- "attributes": {
- "alcoholTobaccoOrDrugUseOrReferences": "NONE",
- "gamblingAndContests": true,
- "gamblingSimulated": "NONE",
- "kidsAgeBand": "FIVE_AND_UNDER",
- "medicalOrTreatmentInformation": "NONE",
- "profanityOrCrudeHumor": "NONE",
- "sexualContentGraphicAndNudity": "NONE",
- "sexualContentOrNudity": "NONE",
- "horrorOrFearThemes": "NONE",
- "matureOrSuggestiveThemes": "NONE",
- "unrestrictedWebAccess": true,
- "violenceCartoonOrFantasy": "NONE",
- "violenceRealisticProlongedGraphicOrSadistic": "NONE",
- "violenceRealistic": "NONE"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
Related linkage
required | object |
{- "data": {
- "type": "builds",
- "id": "string"
}
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[appStoreVersions.appStoreState] | Array of strings Items Enum: "DEVELOPER_REMOVED_FROM_SALE" "DEVELOPER_REJECTED" "IN_REVIEW" "INVALID_BINARY" "METADATA_REJECTED" "PENDING_APPLE_RELEASE" "PENDING_CONTRACT" "PENDING_DEVELOPER_RELEASE" "PREPARE_FOR_SUBMISSION" "PREORDER_READY_FOR_SALE" "PROCESSING_FOR_APP_STORE" "READY_FOR_SALE" "REJECTED" "REMOVED_FROM_SALE" "WAITING_FOR_EXPORT_COMPLIANCE" "WAITING_FOR_REVIEW" "REPLACED_WITH_NEW_VERSION" filter by attribute 'appStoreVersions.appStoreState' |
| filter[appStoreVersions.platform] | Array of strings Items Enum: "IOS" "MAC_OS" "TV_OS" filter by attribute 'appStoreVersions.platform' |
| filter[bundleId] | Array of strings filter by attribute 'bundleId' |
| filter[name] | Array of strings filter by attribute 'name' |
| filter[sku] | Array of strings filter by attribute 'sku' |
| filter[appStoreVersions] | Array of strings filter by id(s) of related 'appStoreVersions' |
| filter[id] | Array of strings filter by id(s) |
| exists[gameCenterEnabledVersions] | Array of strings filter by existence or non-existence of related 'gameCenterEnabledVersions' |
| sort | Array of strings Items Enum: "bundleId" "-bundleId" "name" "-name" "sku" "-sku" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "builds" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "preOrder" "preReleaseVersions" "prices" comma-separated list of relationships to include |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| fields[perfPowerMetrics] | Array of strings Items Enum: "deviceType" "metricType" "platform" the fields to include for returned resources of type perfPowerMetrics |
| fields[appInfos] | Array of strings Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo" the fields to include for returned resources of type appInfos |
| fields[appPreOrders] | Array of strings Items Enum: "app" "appReleaseDate" "preOrderAvailableDate" the fields to include for returned resources of type appPreOrders |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| fields[appPrices] | Array of strings Items Enum: "app" "priceTier" the fields to include for returned resources of type appPrices |
| fields[inAppPurchases] | Array of strings Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state" the fields to include for returned resources of type inAppPurchases |
| fields[betaAppReviewDetails] | Array of strings Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type betaAppReviewDetails |
| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
| fields[gameCenterEnabledVersions] | Array of strings Items Enum: "app" "compatibleVersions" "iconAsset" "platform" "versionString" the fields to include for returned resources of type gameCenterEnabledVersions |
| fields[appStoreVersions] | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString" the fields to include for returned resources of type appStoreVersions |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[betaAppLocalizations] | Array of strings Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy" the fields to include for returned resources of type betaAppLocalizations |
| fields[betaLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" the fields to include for returned resources of type betaLicenseAgreements |
| fields[endUserLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" "territories" the fields to include for returned resources of type endUserLicenseAgreements |
| limit[appInfos] | integer <= 50 maximum number of related appInfos returned (when they are included) |
| limit[appStoreVersions] | integer <= 50 maximum number of related appStoreVersions returned (when they are included) |
| limit[availableTerritories] | integer <= 50 maximum number of related availableTerritories returned (when they are included) |
| limit[betaAppLocalizations] | integer <= 50 maximum number of related betaAppLocalizations returned (when they are included) |
| limit[betaGroups] | integer <= 50 maximum number of related betaGroups returned (when they are included) |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
| limit[gameCenterEnabledVersions] | integer <= 50 maximum number of related gameCenterEnabledVersions returned (when they are included) |
| limit[inAppPurchases] | integer <= 50 maximum number of related inAppPurchases returned (when they are included) |
| limit[preReleaseVersions] | integer <= 50 maximum number of related preReleaseVersions returned (when they are included) |
| limit[prices] | integer <= 50 maximum number of related prices returned (when they are included) |
{- "data": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| include | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "builds" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "preOrder" "preReleaseVersions" "prices" comma-separated list of relationships to include |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| fields[perfPowerMetrics] | Array of strings Items Enum: "deviceType" "metricType" "platform" the fields to include for returned resources of type perfPowerMetrics |
| fields[appInfos] | Array of strings Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo" the fields to include for returned resources of type appInfos |
| fields[appPreOrders] | Array of strings Items Enum: "app" "appReleaseDate" "preOrderAvailableDate" the fields to include for returned resources of type appPreOrders |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| fields[appPrices] | Array of strings Items Enum: "app" "priceTier" the fields to include for returned resources of type appPrices |
| fields[inAppPurchases] | Array of strings Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state" the fields to include for returned resources of type inAppPurchases |
| fields[betaAppReviewDetails] | Array of strings Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type betaAppReviewDetails |
| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
| fields[gameCenterEnabledVersions] | Array of strings Items Enum: "app" "compatibleVersions" "iconAsset" "platform" "versionString" the fields to include for returned resources of type gameCenterEnabledVersions |
| fields[appStoreVersions] | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString" the fields to include for returned resources of type appStoreVersions |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[betaAppLocalizations] | Array of strings Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy" the fields to include for returned resources of type betaAppLocalizations |
| fields[betaLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" the fields to include for returned resources of type betaLicenseAgreements |
| fields[endUserLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" "territories" the fields to include for returned resources of type endUserLicenseAgreements |
| limit[appInfos] | integer <= 50 maximum number of related appInfos returned (when they are included) |
| limit[appStoreVersions] | integer <= 50 maximum number of related appStoreVersions returned (when they are included) |
| limit[availableTerritories] | integer <= 50 maximum number of related availableTerritories returned (when they are included) |
| limit[betaAppLocalizations] | integer <= 50 maximum number of related betaAppLocalizations returned (when they are included) |
| limit[betaGroups] | integer <= 50 maximum number of related betaGroups returned (when they are included) |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
| limit[gameCenterEnabledVersions] | integer <= 50 maximum number of related gameCenterEnabledVersions returned (when they are included) |
| limit[inAppPurchases] | integer <= 50 maximum number of related inAppPurchases returned (when they are included) |
| limit[preReleaseVersions] | integer <= 50 maximum number of related preReleaseVersions returned (when they are included) |
| limit[prices] | integer <= 50 maximum number of related prices returned (when they are included) |
{- "data": {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
App representation
required | object |
{- "data": {
- "type": "apps",
- "id": "string",
- "attributes": {
- "bundleId": "string",
- "primaryLocale": "string",
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "prices": {
- "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[locale] | Array of strings filter by attribute 'locale' |
| filter[app] | Array of strings filter by id(s) of related 'app' |
| fields[betaAppLocalizations] | Array of strings Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy" the fields to include for returned resources of type betaAppLocalizations |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string",
- "locale": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BetaAppLocalization representation
required | object |
{- "data": {
- "type": "betaAppLocalizations",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string",
- "locale": "string"
}, - "relationships": {
- "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "betaAppLocalizations",
- "id": "string",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string",
- "locale": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[betaAppLocalizations] | Array of strings Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy" the fields to include for returned resources of type betaAppLocalizations |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": {
- "type": "betaAppLocalizations",
- "id": "string",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string",
- "locale": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BetaAppLocalization representation
required | object |
{- "data": {
- "type": "betaAppLocalizations",
- "id": "string",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string"
}
}
}{- "data": {
- "type": "betaAppLocalizations",
- "id": "string",
- "attributes": {
- "feedbackEmail": "string",
- "marketingUrl": "string",
- "privacyPolicyUrl": "string",
- "tvOsPrivacyPolicy": "string",
- "description": "string",
- "locale": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[app] required | Array of strings filter by id(s) of related 'app' |
| fields[betaAppReviewDetails] | Array of strings Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type betaAppReviewDetails |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": [
- {
- "type": "betaAppReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[betaAppReviewDetails] | Array of strings Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes" the fields to include for returned resources of type betaAppReviewDetails |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": {
- "type": "betaAppReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BetaAppReviewDetail representation
required | object |
{- "data": {
- "type": "betaAppReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}
}
}{- "data": {
- "type": "betaAppReviewDetails",
- "id": "string",
- "attributes": {
- "contactFirstName": "string",
- "contactLastName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "demoAccountName": "string",
- "demoAccountPassword": "string",
- "demoAccountRequired": true,
- "notes": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| filter[betaReviewState] | Array of strings Items Enum: "WAITING_FOR_REVIEW" "IN_REVIEW" "REJECTED" "APPROVED" filter by attribute 'betaReviewState' |
| filter[build] required | Array of strings filter by id(s) of related 'build' |
| fields[betaAppReviewSubmissions] | Array of strings Items Enum: "betaReviewState" "build" the fields to include for returned resources of type betaAppReviewSubmissions |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": [
- {
- "type": "betaAppReviewSubmissions",
- "id": "string",
- "attributes": {
- "betaReviewState": "WAITING_FOR_REVIEW"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BetaAppReviewSubmission representation
required | object |
{- "data": {
- "type": "betaAppReviewSubmissions",
- "relationships": {
- "build": {
- "data": {
- "type": "builds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string",
- "attributes": {
- "betaReviewState": "WAITING_FOR_REVIEW"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[betaAppReviewSubmissions] | Array of strings Items Enum: "betaReviewState" "build" the fields to include for returned resources of type betaAppReviewSubmissions |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string",
- "attributes": {
- "betaReviewState": "WAITING_FOR_REVIEW"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| filter[locale] | Array of strings filter by attribute 'locale' |
| filter[build] | Array of strings filter by id(s) of related 'build' |
| fields[betaBuildLocalizations] | Array of strings Items Enum: "build" "locale" "whatsNew" the fields to include for returned resources of type betaBuildLocalizations |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string",
- "attributes": {
- "whatsNew": "string",
- "locale": "string"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BetaBuildLocalization representation
required | object |
{- "data": {
- "type": "betaBuildLocalizations",
- "attributes": {
- "whatsNew": "string",
- "locale": "string"
}, - "relationships": {
- "build": {
- "data": {
- "type": "builds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "betaBuildLocalizations",
- "id": "string",
- "attributes": {
- "whatsNew": "string",
- "locale": "string"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[betaBuildLocalizations] | Array of strings Items Enum: "build" "locale" "whatsNew" the fields to include for returned resources of type betaBuildLocalizations |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": {
- "type": "betaBuildLocalizations",
- "id": "string",
- "attributes": {
- "whatsNew": "string",
- "locale": "string"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BetaBuildLocalization representation
required | object |
{- "data": {
- "type": "betaBuildLocalizations",
- "id": "string",
- "attributes": {
- "whatsNew": "string"
}
}
}{- "data": {
- "type": "betaBuildLocalizations",
- "id": "string",
- "attributes": {
- "whatsNew": "string",
- "locale": "string"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[isInternalGroup] | Array of strings filter by attribute 'isInternalGroup' |
| filter[name] | Array of strings filter by attribute 'name' |
| filter[publicLink] | Array of strings filter by attribute 'publicLink' |
| filter[publicLinkEnabled] | Array of strings filter by attribute 'publicLinkEnabled' |
| filter[publicLinkLimitEnabled] | Array of strings filter by attribute 'publicLinkLimitEnabled' |
| filter[app] | Array of strings filter by id(s) of related 'app' |
| filter[builds] | Array of strings filter by id(s) of related 'builds' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "createdDate" "-createdDate" "name" "-name" "publicLinkEnabled" "-publicLinkEnabled" "publicLinkLimit" "-publicLinkLimit" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "app" "betaTesters" "builds" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[betaTesters] | integer <= 50 maximum number of related betaTesters returned (when they are included) |
| limit[builds] | integer <= 1000 maximum number of related builds returned (when they are included) |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BetaGroup representation
required | object |
{- "data": {
- "type": "betaGroups",
- "attributes": {
- "name": "string",
- "publicLinkEnabled": true,
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| include | Array of strings Items Enum: "app" "betaTesters" "builds" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[betaTesters] | integer <= 50 maximum number of related betaTesters returned (when they are included) |
| limit[builds] | integer <= 1000 maximum number of related builds returned (when they are included) |
{- "data": {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BetaGroup representation
required | object |
{- "data": {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "publicLinkEnabled": true,
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "feedbackEnabled": true
}
}
}{- "data": {
- "type": "betaGroups",
- "id": "string",
- "attributes": {
- "name": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "isInternalGroup": true,
- "publicLinkEnabled": true,
- "publicLinkId": "string",
- "publicLinkLimitEnabled": true,
- "publicLinkLimit": 0,
- "publicLink": "string",
- "feedbackEnabled": true
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[app] | Array of strings filter by id(s) of related 'app' |
| fields[betaLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" the fields to include for returned resources of type betaLicenseAgreements |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": [
- {
- "type": "betaLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[betaLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" the fields to include for returned resources of type betaLicenseAgreements |
| include | Array of strings Items Value: "app" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
{- "data": {
- "type": "betaLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BetaLicenseAgreement representation
required | object |
{- "data": {
- "type": "betaLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}
}
}{- "data": {
- "type": "betaLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}BetaTesterInvitation representation
required | object |
{- "data": {
- "type": "betaTesterInvitations",
- "relationships": {
- "betaTester": {
- "data": {
- "type": "betaTesters",
- "id": "string"
}
}, - "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "betaTesterInvitations",
- "id": "string",
- "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| filter[email] | Array of strings filter by attribute 'email' |
| filter[firstName] | Array of strings filter by attribute 'firstName' |
| filter[inviteType] | Array of strings Items Enum: "EMAIL" "PUBLIC_LINK" filter by attribute 'inviteType' |
| filter[lastName] | Array of strings filter by attribute 'lastName' |
| filter[apps] | Array of strings filter by id(s) of related 'apps' |
| filter[betaGroups] | Array of strings filter by id(s) of related 'betaGroups' |
| filter[builds] | Array of strings filter by id(s) of related 'builds' |
| sort | Array of strings Items Enum: "email" "-email" "firstName" "-firstName" "inviteType" "-inviteType" "lastName" "-lastName" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "apps" "betaGroups" "builds" comma-separated list of relationships to include |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[apps] | integer <= 50 maximum number of related apps returned (when they are included) |
| limit[betaGroups] | integer <= 50 maximum number of related betaGroups returned (when they are included) |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string",
- "attributes": {
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "inviteType": "EMAIL"
}, - "relationships": {
- "apps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}, - "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BetaTester representation
required | object |
{- "data": {
- "type": "betaTesters",
- "attributes": {
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "relationships": {
- "betaGroups": {
- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "builds": {
- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "betaTesters",
- "id": "string",
- "attributes": {
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "inviteType": "EMAIL"
}, - "relationships": {
- "apps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}, - "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| include | Array of strings Items Enum: "apps" "betaGroups" "builds" comma-separated list of relationships to include |
| fields[betaGroups] | Array of strings Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled" the fields to include for returned resources of type betaGroups |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[apps] | integer <= 50 maximum number of related apps returned (when they are included) |
| limit[betaGroups] | integer <= 50 maximum number of related betaGroups returned (when they are included) |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
{- "data": {
- "type": "betaTesters",
- "id": "string",
- "attributes": {
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "inviteType": "EMAIL"
}, - "relationships": {
- "apps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}, - "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[build] | Array of strings filter by id(s) of related 'build' |
| filter[id] | Array of strings filter by id(s) |
| fields[buildBetaDetails] | Array of strings Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState" the fields to include for returned resources of type buildBetaDetails |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": [
- {
- "type": "buildBetaDetails",
- "id": "string",
- "attributes": {
- "autoNotifyEnabled": true,
- "internalBuildState": "PROCESSING",
- "externalBuildState": "PROCESSING"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[buildBetaDetails] | Array of strings Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState" the fields to include for returned resources of type buildBetaDetails |
| include | Array of strings Items Value: "build" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
{- "data": {
- "type": "buildBetaDetails",
- "id": "string",
- "attributes": {
- "autoNotifyEnabled": true,
- "internalBuildState": "PROCESSING",
- "externalBuildState": "PROCESSING"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BuildBetaDetail representation
required | object |
{- "data": {
- "type": "buildBetaDetails",
- "id": "string",
- "attributes": {
- "autoNotifyEnabled": true
}
}
}{- "data": {
- "type": "buildBetaDetails",
- "id": "string",
- "attributes": {
- "autoNotifyEnabled": true,
- "internalBuildState": "PROCESSING",
- "externalBuildState": "PROCESSING"
}, - "relationships": {
- "build": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "builds",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}BuildBetaNotification representation
required | object |
{- "data": {
- "type": "buildBetaNotifications",
- "relationships": {
- "build": {
- "data": {
- "type": "builds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "buildBetaNotifications",
- "id": "string",
- "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| filter[betaAppReviewSubmission.betaReviewState] | Array of strings Items Enum: "WAITING_FOR_REVIEW" "IN_REVIEW" "REJECTED" "APPROVED" filter by attribute 'betaAppReviewSubmission.betaReviewState' |
| filter[expired] | Array of strings filter by attribute 'expired' |
| filter[preReleaseVersion.platform] | Array of strings Items Enum: "IOS" "MAC_OS" "TV_OS" filter by attribute 'preReleaseVersion.platform' |
| filter[preReleaseVersion.version] | Array of strings filter by attribute 'preReleaseVersion.version' |
| filter[processingState] | Array of strings Items Enum: "PROCESSING" "FAILED" "INVALID" "VALID" filter by attribute 'processingState' |
| filter[usesNonExemptEncryption] | Array of strings filter by attribute 'usesNonExemptEncryption' |
| filter[version] | Array of strings filter by attribute 'version' |
| filter[app] | Array of strings filter by id(s) of related 'app' |
| filter[appStoreVersion] | Array of strings filter by id(s) of related 'appStoreVersion' |
| filter[betaGroups] | Array of strings filter by id(s) of related 'betaGroups' |
| filter[preReleaseVersion] | Array of strings filter by id(s) of related 'preReleaseVersion' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "preReleaseVersion" "-preReleaseVersion" "uploadedDate" "-uploadedDate" "version" "-version" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "buildBetaDetail" "icons" "individualTesters" "preReleaseVersion" comma-separated list of relationships to include |
| fields[appEncryptionDeclarations] | Array of strings Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption" the fields to include for returned resources of type appEncryptionDeclarations |
| fields[betaAppReviewSubmissions] | Array of strings Items Enum: "betaReviewState" "build" the fields to include for returned resources of type betaAppReviewSubmissions |
| fields[buildBetaDetails] | Array of strings Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState" the fields to include for returned resources of type buildBetaDetails |
| fields[buildIcons] | Array of strings Items Enum: "iconAsset" "iconType" the fields to include for returned resources of type buildIcons |
| fields[perfPowerMetrics] | Array of strings Items Enum: "deviceType" "metricType" "platform" the fields to include for returned resources of type perfPowerMetrics |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| fields[appStoreVersions] | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString" the fields to include for returned resources of type appStoreVersions |
| fields[diagnosticSignatures] | Array of strings Items Enum: "diagnosticType" "logs" "signature" "weight" the fields to include for returned resources of type diagnosticSignatures |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| fields[betaBuildLocalizations] | Array of strings Items Enum: "build" "locale" "whatsNew" the fields to include for returned resources of type betaBuildLocalizations |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[betaBuildLocalizations] | integer <= 50 maximum number of related betaBuildLocalizations returned (when they are included) |
| limit[icons] | integer <= 50 maximum number of related icons returned (when they are included) |
| limit[individualTesters] | integer <= 50 maximum number of related individualTesters returned (when they are included) |
{- "data": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "preReleaseVersions",
- "id": "string",
- "attributes": {
- "version": "string",
- "platform": "IOS"
}, - "relationships": {
- "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| include | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "buildBetaDetail" "icons" "individualTesters" "preReleaseVersion" comma-separated list of relationships to include |
| fields[appEncryptionDeclarations] | Array of strings Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption" the fields to include for returned resources of type appEncryptionDeclarations |
| fields[betaAppReviewSubmissions] | Array of strings Items Enum: "betaReviewState" "build" the fields to include for returned resources of type betaAppReviewSubmissions |
| fields[buildBetaDetails] | Array of strings Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState" the fields to include for returned resources of type buildBetaDetails |
| fields[buildIcons] | Array of strings Items Enum: "iconAsset" "iconType" the fields to include for returned resources of type buildIcons |
| fields[perfPowerMetrics] | Array of strings Items Enum: "deviceType" "metricType" "platform" the fields to include for returned resources of type perfPowerMetrics |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| fields[appStoreVersions] | Array of strings Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString" the fields to include for returned resources of type appStoreVersions |
| fields[diagnosticSignatures] | Array of strings Items Enum: "diagnosticType" "logs" "signature" "weight" the fields to include for returned resources of type diagnosticSignatures |
| fields[betaTesters] | Array of strings Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName" the fields to include for returned resources of type betaTesters |
| fields[betaBuildLocalizations] | Array of strings Items Enum: "build" "locale" "whatsNew" the fields to include for returned resources of type betaBuildLocalizations |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[betaBuildLocalizations] | integer <= 50 maximum number of related betaBuildLocalizations returned (when they are included) |
| limit[icons] | integer <= 50 maximum number of related icons returned (when they are included) |
| limit[individualTesters] | integer <= 50 maximum number of related individualTesters returned (when they are included) |
{- "data": {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "preReleaseVersions",
- "id": "string",
- "attributes": {
- "version": "string",
- "platform": "IOS"
}, - "relationships": {
- "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
Build representation
required | object |
{- "data": {
- "type": "builds",
- "id": "string",
- "attributes": {
- "expired": true,
- "usesNonExemptEncryption": true
}, - "relationships": {
- "appEncryptionDeclaration": {
- "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "preReleaseVersions",
- "id": "string",
- "attributes": {
- "version": "string",
- "platform": "IOS"
}, - "relationships": {
- "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
Related linkage
required | object |
{- "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}BundleIdCapability representation
required | object |
{- "data": {
- "type": "bundleIdCapabilities",
- "attributes": {
- "capabilityType": "ICLOUD",
- "settings": [
- {
- "key": "ICLOUD_VERSION",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "visible": true,
- "allowedInstances": "ENTRY",
- "minInstances": 0,
- "options": [
- {
- "key": "XCODE_5",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "enabled": true,
- "supportsWildcard": true
}
]
}
]
}, - "relationships": {
- "bundleId": {
- "data": {
- "type": "bundleIds",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "bundleIdCapabilities",
- "id": "string",
- "attributes": {
- "capabilityType": "ICLOUD",
- "settings": [
- {
- "key": "ICLOUD_VERSION",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "visible": true,
- "allowedInstances": "ENTRY",
- "minInstances": 0,
- "options": [
- {
- "key": "XCODE_5",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "enabled": true,
- "supportsWildcard": true
}
]
}
]
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BundleIdCapability representation
required | object |
{- "data": {
- "type": "bundleIdCapabilities",
- "id": "string",
- "attributes": {
- "capabilityType": "ICLOUD",
- "settings": [
- {
- "key": "ICLOUD_VERSION",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "visible": true,
- "allowedInstances": "ENTRY",
- "minInstances": 0,
- "options": [
- {
- "key": "XCODE_5",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "enabled": true,
- "supportsWildcard": true
}
]
}
]
}
}
}{- "data": {
- "type": "bundleIdCapabilities",
- "id": "string",
- "attributes": {
- "capabilityType": "ICLOUD",
- "settings": [
- {
- "key": "ICLOUD_VERSION",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "visible": true,
- "allowedInstances": "ENTRY",
- "minInstances": 0,
- "options": [
- {
- "key": "XCODE_5",
- "name": "string",
- "description": "string",
- "enabledByDefault": true,
- "enabled": true,
- "supportsWildcard": true
}
]
}
]
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[identifier] | Array of strings filter by attribute 'identifier' |
| filter[name] | Array of strings filter by attribute 'name' |
| filter[platform] | Array of strings Items Enum: "IOS" "MAC_OS" filter by attribute 'platform' |
| filter[seedId] | Array of strings filter by attribute 'seedId' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "id" "-id" "identifier" "-identifier" "name" "-name" "platform" "-platform" "seedId" "-seedId" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[bundleIds] | Array of strings Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId" the fields to include for returned resources of type bundleIds |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "app" "bundleIdCapabilities" "profiles" comma-separated list of relationships to include |
| fields[bundleIdCapabilities] | Array of strings Items Enum: "bundleId" "capabilityType" "settings" the fields to include for returned resources of type bundleIdCapabilities |
| fields[profiles] | Array of strings Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid" the fields to include for returned resources of type profiles |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[bundleIdCapabilities] | integer <= 50 maximum number of related bundleIdCapabilities returned (when they are included) |
| limit[profiles] | integer <= 50 maximum number of related profiles returned (when they are included) |
{- "data": [
- {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}BundleId representation
required | object |
{- "data": {
- "type": "bundleIds",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}
}
}{- "data": {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[bundleIds] | Array of strings Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId" the fields to include for returned resources of type bundleIds |
| include | Array of strings Items Enum: "app" "bundleIdCapabilities" "profiles" comma-separated list of relationships to include |
| fields[bundleIdCapabilities] | Array of strings Items Enum: "bundleId" "capabilityType" "settings" the fields to include for returned resources of type bundleIdCapabilities |
| fields[profiles] | Array of strings Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid" the fields to include for returned resources of type profiles |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[bundleIdCapabilities] | integer <= 50 maximum number of related bundleIdCapabilities returned (when they are included) |
| limit[profiles] | integer <= 50 maximum number of related profiles returned (when they are included) |
{- "data": {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
BundleId representation
required | object |
{- "data": {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string"
}
}
}{- "data": {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[certificateType] | Array of strings Items Enum: "IOS_DEVELOPMENT" "IOS_DISTRIBUTION" "MAC_APP_DISTRIBUTION" "MAC_INSTALLER_DISTRIBUTION" "MAC_APP_DEVELOPMENT" "DEVELOPER_ID_KEXT" "DEVELOPER_ID_APPLICATION" "DEVELOPMENT" "DISTRIBUTION" filter by attribute 'certificateType' |
| filter[displayName] | Array of strings filter by attribute 'displayName' |
| filter[serialNumber] | Array of strings filter by attribute 'serialNumber' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "certificateType" "-certificateType" "displayName" "-displayName" "id" "-id" "serialNumber" "-serialNumber" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[certificates] | Array of strings Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber" the fields to include for returned resources of type certificates |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "certificates",
- "id": "string",
- "attributes": {
- "name": "string",
- "certificateType": "IOS_DEVELOPMENT",
- "displayName": "string",
- "serialNumber": "string",
- "platform": "IOS",
- "expirationDate": "2019-08-24T14:15:22Z",
- "certificateContent": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}Certificate representation
required | object |
{- "data": {
- "type": "certificates",
- "attributes": {
- "csrContent": "string",
- "certificateType": "IOS_DEVELOPMENT"
}
}
}{- "data": {
- "type": "certificates",
- "id": "string",
- "attributes": {
- "name": "string",
- "certificateType": "IOS_DEVELOPMENT",
- "displayName": "string",
- "serialNumber": "string",
- "platform": "IOS",
- "expirationDate": "2019-08-24T14:15:22Z",
- "certificateContent": "string"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[certificates] | Array of strings Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber" the fields to include for returned resources of type certificates |
{- "data": {
- "type": "certificates",
- "id": "string",
- "attributes": {
- "name": "string",
- "certificateType": "IOS_DEVELOPMENT",
- "displayName": "string",
- "serialNumber": "string",
- "platform": "IOS",
- "expirationDate": "2019-08-24T14:15:22Z",
- "certificateContent": "string"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[name] | Array of strings filter by attribute 'name' |
| filter[platform] | Array of strings Items Enum: "IOS" "MAC_OS" filter by attribute 'platform' |
| filter[status] | Array of strings Items Enum: "ENABLED" "DISABLED" filter by attribute 'status' |
| filter[udid] | Array of strings filter by attribute 'udid' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "id" "-id" "name" "-name" "platform" "-platform" "status" "-status" "udid" "-udid" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[devices] | Array of strings Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid" the fields to include for returned resources of type devices |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "devices",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "udid": "string",
- "deviceClass": "APPLE_WATCH",
- "status": "ENABLED",
- "model": "string",
- "addedDate": "2019-08-24T14:15:22Z"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}Device representation
required | object |
{- "data": {
- "type": "devices",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "udid": "string"
}
}
}{- "data": {
- "type": "devices",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "udid": "string",
- "deviceClass": "APPLE_WATCH",
- "status": "ENABLED",
- "model": "string",
- "addedDate": "2019-08-24T14:15:22Z"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[devices] | Array of strings Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid" the fields to include for returned resources of type devices |
{- "data": {
- "type": "devices",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "udid": "string",
- "deviceClass": "APPLE_WATCH",
- "status": "ENABLED",
- "model": "string",
- "addedDate": "2019-08-24T14:15:22Z"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
Device representation
required | object |
{- "data": {
- "type": "devices",
- "id": "string",
- "attributes": {
- "name": "string",
- "status": "ENABLED"
}
}
}{- "data": {
- "type": "devices",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "udid": "string",
- "deviceClass": "APPLE_WATCH",
- "status": "ENABLED",
- "model": "string",
- "addedDate": "2019-08-24T14:15:22Z"
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}EndUserLicenseAgreement representation
required | object |
{- "data": {
- "type": "endUserLicenseAgreements",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "data": {
- "type": "apps",
- "id": "string"
}
}, - "territories": {
- "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "endUserLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "territories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[endUserLicenseAgreements] | Array of strings Items Enum: "agreementText" "app" "territories" the fields to include for returned resources of type endUserLicenseAgreements |
| include | Array of strings Items Enum: "app" "territories" comma-separated list of relationships to include |
| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
| limit[territories] | integer <= 50 maximum number of related territories returned (when they are included) |
{- "data": {
- "type": "endUserLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "territories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
EndUserLicenseAgreement representation
required | object |
{- "data": {
- "type": "endUserLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "territories": {
- "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "endUserLicenseAgreements",
- "id": "string",
- "attributes": {
- "agreementText": "string"
}, - "relationships": {
- "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "territories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[regionCode] required | Array of strings filter by attribute 'regionCode' |
| filter[reportDate] required | Array of strings filter by attribute 'reportDate' |
| filter[reportType] required | Array of strings Items Enum: "FINANCIAL" "FINANCE_DETAIL" filter by attribute 'reportType' |
| filter[vendorNumber] required | Array of strings filter by attribute 'vendorNumber' |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}IdfaDeclaration representation
required | object |
{- "data": {
- "type": "idfaDeclarations",
- "attributes": {
- "servesAds": true,
- "attributesAppInstallationToPreviousAd": true,
- "attributesActionWithPreviousAd": true,
- "honorsLimitedAdTracking": true
}, - "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "idfaDeclarations",
- "id": "string",
- "attributes": {
- "servesAds": true,
- "attributesAppInstallationToPreviousAd": true,
- "attributesActionWithPreviousAd": true,
- "honorsLimitedAdTracking": true
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
IdfaDeclaration representation
required | object |
{- "data": {
- "type": "idfaDeclarations",
- "id": "string",
- "attributes": {
- "servesAds": true,
- "attributesAppInstallationToPreviousAd": true,
- "attributesActionWithPreviousAd": true,
- "honorsLimitedAdTracking": true
}
}
}{- "data": {
- "type": "idfaDeclarations",
- "id": "string",
- "attributes": {
- "servesAds": true,
- "attributesAppInstallationToPreviousAd": true,
- "attributesActionWithPreviousAd": true,
- "honorsLimitedAdTracking": true
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| fields[inAppPurchases] | Array of strings Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state" the fields to include for returned resources of type inAppPurchases |
| include | Array of strings Items Value: "apps" comma-separated list of relationships to include |
| limit[apps] | integer <= 50 maximum number of related apps returned (when they are included) |
{- "data": {
- "type": "inAppPurchases",
- "id": "string",
- "attributes": {
- "referenceName": "string",
- "productId": "string",
- "inAppPurchaseType": "AUTOMATICALLY_RENEWABLE_SUBSCRIPTION",
- "state": "CREATED"
}, - "relationships": {
- "apps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| filter[builds.expired] | Array of strings filter by attribute 'builds.expired' |
| filter[builds.processingState] | Array of strings Items Enum: "PROCESSING" "FAILED" "INVALID" "VALID" filter by attribute 'builds.processingState' |
| filter[platform] | Array of strings Items Enum: "IOS" "MAC_OS" "TV_OS" filter by attribute 'platform' |
| filter[version] | Array of strings filter by attribute 'version' |
| filter[app] | Array of strings filter by id(s) of related 'app' |
| filter[builds] | Array of strings filter by id(s) of related 'builds' |
| sort | Array of strings Items Enum: "version" "-version" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "app" "builds" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
{- "data": [
- {
- "type": "preReleaseVersions",
- "id": "string",
- "attributes": {
- "version": "string",
- "platform": "IOS"
}, - "relationships": {
- "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[preReleaseVersions] | Array of strings Items Enum: "app" "builds" "platform" "version" the fields to include for returned resources of type preReleaseVersions |
| include | Array of strings Items Enum: "app" "builds" comma-separated list of relationships to include |
| fields[builds] | Array of strings Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version" the fields to include for returned resources of type builds |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[builds] | integer <= 50 maximum number of related builds returned (when they are included) |
{- "data": {
- "type": "preReleaseVersions",
- "id": "string",
- "attributes": {
- "version": "string",
- "platform": "IOS"
}, - "relationships": {
- "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "builds",
- "id": "string",
- "attributes": {
- "version": "string",
- "uploadedDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "expired": true,
- "minOsVersion": "string",
- "iconAssetToken": {
- "templateUrl": "string",
- "width": 0,
- "height": 0
}, - "processingState": "PROCESSING",
- "usesNonExemptEncryption": true
}, - "relationships": {
- "preReleaseVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "preReleaseVersions",
- "id": "string"
}
}, - "individualTesters": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaTesters",
- "id": "string"
}
]
}, - "betaBuildLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaBuildLocalizations",
- "id": "string"
}
]
}, - "appEncryptionDeclaration": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appEncryptionDeclarations",
- "id": "string"
}
}, - "betaAppReviewSubmission": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewSubmissions",
- "id": "string"
}
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}, - "buildBetaDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "buildBetaDetails",
- "id": "string"
}
}, - "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}, - "icons": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "buildIcons",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| filter[name] | Array of strings filter by attribute 'name' |
| filter[profileState] | Array of strings Items Enum: "ACTIVE" "INVALID" filter by attribute 'profileState' |
| filter[profileType] | Array of strings Items Enum: "IOS_APP_DEVELOPMENT" "IOS_APP_STORE" "IOS_APP_ADHOC" "IOS_APP_INHOUSE" "MAC_APP_DEVELOPMENT" "MAC_APP_STORE" "MAC_APP_DIRECT" "TVOS_APP_DEVELOPMENT" "TVOS_APP_STORE" "TVOS_APP_ADHOC" "TVOS_APP_INHOUSE" "MAC_CATALYST_APP_DEVELOPMENT" "MAC_CATALYST_APP_STORE" "MAC_CATALYST_APP_DIRECT" filter by attribute 'profileType' |
| filter[id] | Array of strings filter by id(s) |
| sort | Array of strings Items Enum: "id" "-id" "name" "-name" "profileState" "-profileState" "profileType" "-profileType" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[profiles] | Array of strings Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid" the fields to include for returned resources of type profiles |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Enum: "bundleId" "certificates" "devices" comma-separated list of relationships to include |
| fields[certificates] | Array of strings Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber" the fields to include for returned resources of type certificates |
| fields[devices] | Array of strings Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid" the fields to include for returned resources of type devices |
| fields[bundleIds] | Array of strings Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId" the fields to include for returned resources of type bundleIds |
| limit[certificates] | integer <= 50 maximum number of related certificates returned (when they are included) |
| limit[devices] | integer <= 50 maximum number of related devices returned (when they are included) |
{- "data": [
- {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}Profile representation
required | object |
{- "data": {
- "type": "profiles",
- "attributes": {
- "name": "string",
- "profileType": "IOS_APP_DEVELOPMENT"
}, - "relationships": {
- "bundleId": {
- "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[profiles] | Array of strings Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid" the fields to include for returned resources of type profiles |
| include | Array of strings Items Enum: "bundleId" "certificates" "devices" comma-separated list of relationships to include |
| fields[certificates] | Array of strings Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber" the fields to include for returned resources of type certificates |
| fields[devices] | Array of strings Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid" the fields to include for returned resources of type devices |
| fields[bundleIds] | Array of strings Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId" the fields to include for returned resources of type bundleIds |
| limit[certificates] | integer <= 50 maximum number of related certificates returned (when they are included) |
| limit[devices] | integer <= 50 maximum number of related devices returned (when they are included) |
{- "data": {
- "type": "profiles",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "profileType": "IOS_APP_DEVELOPMENT",
- "profileState": "ACTIVE",
- "profileContent": "string",
- "uuid": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "bundleId": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "bundleIds",
- "id": "string"
}
}, - "devices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "devices",
- "id": "string"
}
]
}, - "certificates": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "certificates",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "bundleIds",
- "id": "string",
- "attributes": {
- "name": "string",
- "platform": "IOS",
- "identifier": "string",
- "seedId": "string"
}, - "relationships": {
- "profiles": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "profiles",
- "id": "string"
}
]
}, - "bundleIdCapabilities": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "bundleIdCapabilities",
- "id": "string"
}
]
}, - "app": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "apps",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}RoutingAppCoverage representation
required | object |
{- "data": {
- "type": "routingAppCoverages",
- "attributes": {
- "fileSize": 0,
- "fileName": "string"
}, - "relationships": {
- "appStoreVersion": {
- "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}
}
}{- "data": {
- "type": "routingAppCoverages",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[routingAppCoverages] | Array of strings Items Enum: "appStoreVersion" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded" the fields to include for returned resources of type routingAppCoverages |
| include | Array of strings Items Value: "appStoreVersion" comma-separated list of relationships to include |
{- "data": {
- "type": "routingAppCoverages",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
RoutingAppCoverage representation
required | object |
{- "data": {
- "type": "routingAppCoverages",
- "id": "string",
- "attributes": {
- "sourceFileChecksum": "string",
- "uploaded": true
}
}
}{- "data": {
- "type": "routingAppCoverages",
- "id": "string",
- "attributes": {
- "fileSize": 0,
- "fileName": "string",
- "sourceFileChecksum": "string",
- "uploadOperations": [
- {
- "method": "string",
- "url": "string",
- "length": 0,
- "offset": 0,
- "requestHeaders": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "assetDeliveryState": {
- "errors": [
- {
- "code": "string",
- "description": "string"
}
], - "warnings": [
- {
- "code": "string",
- "description": "string"
}
], - "state": "AWAITING_UPLOAD"
}
}, - "relationships": {
- "appStoreVersion": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appStoreVersions",
- "id": "string"
}
}
}, - "links": {
- "self": "string"
}
}, - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[frequency] required | Array of strings Items Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" filter by attribute 'frequency' |
| filter[reportDate] | Array of strings filter by attribute 'reportDate' |
| filter[reportSubType] required | Array of strings Items Enum: "SUMMARY" "DETAILED" "OPT_IN" filter by attribute 'reportSubType' |
| filter[reportType] required | Array of strings Items Enum: "SALES" "PRE_ORDER" "NEWSSTAND" "SUBSCRIPTION" "SUBSCRIPTION_EVENT" "SUBSCRIBER" filter by attribute 'reportType' |
| filter[vendorNumber] required | Array of strings filter by attribute 'vendorNumber' |
| filter[version] | Array of strings filter by attribute 'version' |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| fields[territories] | Array of strings Items Value: "currency" the fields to include for returned resources of type territories |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "territories",
- "id": "string",
- "attributes": {
- "currency": "string"
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| filter[email] | Array of strings filter by attribute 'email' |
| filter[roles] | Array of strings Items Enum: "ADMIN" "FINANCE" "TECHNICAL" "ACCOUNT_HOLDER" "READ_ONLY" "SALES" "MARKETING" "APP_MANAGER" "DEVELOPER" "ACCESS_TO_REPORTS" "CUSTOMER_SUPPORT" filter by attribute 'roles' |
| filter[visibleApps] | Array of strings filter by id(s) of related 'visibleApps' |
| sort | Array of strings Items Enum: "email" "-email" "lastName" "-lastName" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[userInvitations] | Array of strings Items Enum: "allAppsVisible" "email" "expirationDate" "firstName" "lastName" "provisioningAllowed" "roles" "visibleApps" the fields to include for returned resources of type userInvitations |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "visibleApps" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[visibleApps] | integer <= 50 maximum number of related visibleApps returned (when they are included) |
{- "data": [
- {
- "type": "userInvitations",
- "id": "string",
- "attributes": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}UserInvitation representation
required | object |
{- "data": {
- "type": "userInvitations",
- "attributes": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "userInvitations",
- "id": "string",
- "attributes": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
| fields[userInvitations] | Array of strings Items Enum: "allAppsVisible" "email" "expirationDate" "firstName" "lastName" "provisioningAllowed" "roles" "visibleApps" the fields to include for returned resources of type userInvitations |
| include | Array of strings Items Value: "visibleApps" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[visibleApps] | integer <= 50 maximum number of related visibleApps returned (when they are included) |
{- "data": {
- "type": "userInvitations",
- "id": "string",
- "attributes": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| filter[roles] | Array of strings Items Enum: "ADMIN" "FINANCE" "TECHNICAL" "ACCOUNT_HOLDER" "READ_ONLY" "SALES" "MARKETING" "APP_MANAGER" "DEVELOPER" "ACCESS_TO_REPORTS" "CUSTOMER_SUPPORT" filter by attribute 'roles' |
| filter[username] | Array of strings filter by attribute 'username' |
| filter[visibleApps] | Array of strings filter by id(s) of related 'visibleApps' |
| sort | Array of strings Items Enum: "lastName" "-lastName" "username" "-username" comma-separated list of sort expressions; resources will be sorted as specified |
| fields[users] | Array of strings Items Enum: "allAppsVisible" "firstName" "lastName" "provisioningAllowed" "roles" "username" "visibleApps" the fields to include for returned resources of type users |
| limit | integer <= 200 maximum resources per page |
| include | Array of strings Items Value: "visibleApps" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[visibleApps] | integer <= 50 maximum number of related visibleApps returned (when they are included) |
{- "data": [
- {
- "type": "users",
- "id": "string",
- "attributes": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
| fields[users] | Array of strings Items Enum: "allAppsVisible" "firstName" "lastName" "provisioningAllowed" "roles" "username" "visibleApps" the fields to include for returned resources of type users |
| include | Array of strings Items Value: "visibleApps" comma-separated list of relationships to include |
| fields[apps] | Array of strings Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku" the fields to include for returned resources of type apps |
| limit[visibleApps] | integer <= 50 maximum number of related visibleApps returned (when they are included) |
{- "data": {
- "type": "users",
- "id": "string",
- "attributes": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
User representation
required | object |
{- "data": {
- "type": "users",
- "id": "string",
- "attributes": {
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}
}
}{- "data": {
- "type": "users",
- "id": "string",
- "attributes": {
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "ADMIN"
], - "allAppsVisible": true,
- "provisioningAllowed": true
}, - "relationships": {
- "visibleApps": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}, - "included": [
- {
- "type": "apps",
- "id": "string",
- "attributes": {
- "name": "string",
- "bundleId": "string",
- "sku": "string",
- "primaryLocale": "string",
- "isOrEverWasMadeForKids": true,
- "availableInNewTerritories": true,
- "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
}, - "relationships": {
- "betaGroups": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaGroups",
- "id": "string"
}
]
}, - "appStoreVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appStoreVersions",
- "id": "string"
}
]
}, - "preReleaseVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "preReleaseVersions",
- "id": "string"
}
]
}, - "betaAppLocalizations": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "betaAppLocalizations",
- "id": "string"
}
]
}, - "builds": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "builds",
- "id": "string"
}
]
}, - "betaLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaLicenseAgreements",
- "id": "string"
}
}, - "betaAppReviewDetail": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "betaAppReviewDetails",
- "id": "string"
}
}, - "appInfos": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appInfos",
- "id": "string"
}
]
}, - "endUserLicenseAgreement": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "endUserLicenseAgreements",
- "id": "string"
}
}, - "preOrder": {
- "links": {
- "self": "string",
- "related": "string"
}, - "data": {
- "type": "appPreOrders",
- "id": "string"
}
}, - "prices": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "appPrices",
- "id": "string"
}
]
}, - "availableTerritories": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "territories",
- "id": "string"
}
]
}, - "inAppPurchases": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "inAppPurchases",
- "id": "string"
}
]
}, - "gameCenterEnabledVersions": {
- "links": {
- "self": "string",
- "related": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}, - "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}
}, - "links": {
- "self": "string"
}
}
], - "links": {
- "self": "string"
}
}| id required | string the id of the requested resource |
{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "apps",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
| limit | integer <= 200 maximum resources per page |
{- "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
], - "links": {
- "self": "string",
- "first": "string",
- "next": "string"
}, - "meta": {
- "paging": {
- "total": 0,
- "limit": 0
}
}
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}| id required | string the id of the requested resource |
List of related linkages
required | Array of objects |
{- "data": [
- {
- "type": "gameCenterEnabledVersions",
- "id": "string"
}
]
}{- "errors": [
- {
- "id": "string",
- "status": "string",
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "string"
}
}
]
}